Returns statistics for ztnet

Returns various statistics that can be used in 3rd party applications.
Available from version v0.6.4

Responses

• 200
• 401
• 429
• 500

---

An object of statistics

application/json

Schema

Example (from schema)

Example

---

Schema

users integer

The number of users.

networks integer

The number of networks.

networkMembers integer

The total number of network members.

appVersion string

The current version of the ztnet application.

loginsLast24h integer

The number of logins in the last 24 hours.

pendingUserInvitations integer

The number of pending user invitations.

activeWebhooks integer

The number of active webhooks.

ztnetUptime float

The uptime of ztnet in minutes.

registrationEnabled boolean

Indicates if registration is enabled.

hasPrivatRoot boolean

Indicates if a private root is currently in use.

{
  "users": 0,
  "networks": 0,
  "networkMembers": 0,
  "appVersion": "string",
  "loginsLast24h": 0,
  "pendingUserInvitations": 0,
  "activeWebhooks": 0,
  "ztnetUptime": 0,
  "registrationEnabled": true,
  "hasPrivatRoot": true
}

[
  {
    "users": 1,
    "networks": 8,
    "networkMembers": 7,
    "appVersion": "v0.6.3",
    "loginsLast24h": 1,
    "pendingUserInvitations": 0,
    "activeWebhooks": 0,
    "ztnetUptime": 735.491790795,
    "registrationEnabled": false,
    "hasPrivatRoot": true
  }
]

Unauthorized access, indicating that the request has not been applied because it lacks valid authentication credentials for the target resource.

application/json

Schema

Example (from schema)

missingApiKey

invalidApiKey

---

Schema

error string

A message detailing the reason for the unauthorized status.

{
  "error": "Unauthorized: API key is missing or invalid."
}

API key is missing

{
  "error": "Unauthorized: API key is missing."
}

API key is invalid

{
  "error": "Unauthorized: API key is invalid."
}

Rate limit exceeded, indicating that the request was not accepted because the application has exceeded the rate limit for the API.

application/json

Schema

Example (from schema)

rateLimitExceededExample

---

Schema

error string

A message detailing the reason for exceeding the rate limit.

{
  "error": "Rate limit exceeded. Try again in X minutes."
}

Example response for rate limit exceeded

{
  "error": "Rate limit exceeded. Try again in 1 minute."
}

Internal Server Error, indicating that the server encountered an unexpected condition that prevented it from fulfilling the request.

application/json

Schema

Example (from schema)

internalServerErrorExample

---

Schema

error string

A message detailing the unexpected condition encountered by the server.

{
  "error": "Internal server error. Please try again later."
}

Example response for an internal server error

{
  "error": "Internal server error. Please try again later."
}

Loading...